Resource URL: /platform/<<version=3>>/local/cluster/nodes/<LNN>/drives/<DRIVEID>/firmware/update

    Overview: This resource exposes information about the firmware installed on
              the drives on this node

     Methods: GET, POST

********************************************************************************

Method GET: Retrieve firmware update information.

       URL: GET
            /platform/<<version=3>>/local/cluster/nodes/<LNN>/drives/<DRIVEID>/firmware/update

There are no query arguments for this method.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "nodes": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Drive firmware update information.", 
            "properties": {
              "status": {
                "type": "object", 
                "description": "Drive firmware update status information.", 
                "properties": {
                  "status": {
                    "type": "string", 
                    "description": "Overall status of this nodes firmware updates."
                  }, 
                  "updated": {
                    "type": "integer", 
                    "description": "The number of drives that completed firmware updates on the node."
                  }, 
                  "finish_time": {
                    "type": "string", 
                    "description": "Time when drive firmware update finished on node."
                  }, 
                  "start_time": {
                    "type": "string", 
                    "description": "Time when drive firmware update started on node."
                  }, 
                  "failed": {
                    "type": "integer", 
                    "description": "The number of drives that did not successfully complete firmware updates update on the node."
                  }, 
                  "remaining": {
                    "type": "integer", 
                    "description": "Number of drives remaining to be updated on node."
                  }
                }
              }, 
              "lnn": {
                "type": "integer", 
                "description": "Logical Node Number (LNN) of this node."
              }, 
              "id": {
                "type": "integer", 
                "description": "Node ID (Device Number) of this node."
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }
      }
    }
  ]
}

********************************************************************************

Method POST: Start a drive firmware update.

        URL: POST
             /platform/<<version=3>>/local/cluster/nodes/<LNN>/drives/<DRIVEID>/firmware/update

There are no query arguments for this method.

Required POST request body fields:
cluster_wide

POST request body schema:
{
  "type": "object", 
  "description": "Drive firmware update information.", 
  "properties": {
    "cluster_wide": {
      "required": true, 
      "type": "boolean", 
      "description": "Indicates whether this is a cluster wide drive firwmare update or not"
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": [
        "null", 
        "object"
      ], 
      "description": "Null or any empty JSON object.", 
      "properties": {}
    }
  ]
}
